Gao-order-evaluate.json

The evaluate operation examines an order, comparing it against known guidelines for appropriate use and returns the result of that evaluation to the caller.

{
  "resourceType": "OperationDefinition",
  "id": "gao-order-evaluate",
  "text": {
    "status": "generated",
    "div": "<div><h2>Inputs</h2><table class=\"codes\">\n        <thead>\n          <tr>\n            <th><b>Parameters</b></th>\n            <th><b>Card.</b></th>\n            <th><b>Type</b></th>\n            <th><b>Description</b></th>\n          </tr>\n        </thead>\n        <tbody>\n          <tr>\n            <td>order</td>\n            <td>1..1</td>\n            <td><a href=\"../order.html\">Order</a><br/>(<a href=\"gao-order.html\">Guideline\n                Appropriate Order</a>)</td>\n            <td>The order to evaluate</td>\n          </tr>\n          <tr>\n            <td>coverage</td>\n            <td>0..*</td>\n            <td><a href=\"../coverage.html\">Coverage</a></td>\n            <td>Optional resources describing the patient’s coverage.</td>\n          </tr>\n          <tr>\n            <td>answers</td>\n            <td>0..*</td>\n            <td><a href=\"../questionnaireresponse.html\">QuestionnaireResponse</a><br/>(<a href=\"gao-questionnaireresponse.html\">GAO Questionnaire Response</a>)</td>\n            <td>Optional answers to any questions which have been or may be posed by the Decision\n              Support Service</td>\n          </tr>\n        </tbody>\n      </table><h2>Outputs</h2><table class=\"codes\">\n        <thead>\n          <tr>\n            <th><b>Parameters</b></th>\n            <th><b>Card.</b></th>\n            <th><b>Type</b></th>\n            <th><b>Description</b></th>\n          </tr>\n        </thead>\n        <tbody>\n          <tr>\n            <td>order</td>\n            <td>1..1</td>\n            <td><a href=\"../order.html\">Order</a><br/>(<a href=\"gao-order.html\">Guideline\n                Appropriate Order</a>)</td>\n            <td>The order that was evaluated. This is a copy of the order provided on input.</td>\n          </tr>\n          <tr>\n            <td>answers</td>\n            <td>0..*</td>\n            <td><a href=\"../questionnaireresponse.html\">QuestionnaireResponse</a><br/>(<a href=\"gao-questionnaireresponse.html\">GAO Questionnaire Response</a>)</td>\n            <td>Answers to any questions posed by the Decision Support Service. This SHALL be a copy\n              of the answers provided on input.</td>\n          </tr>\n          <tr>\n            <td>result</td>\n            <td>1..1</td>\n            <td><a href=\"../basic.html\">Basic</a><br/>(<a href=\"gao-result.html\">GAO\n              Result</a>)</td>\n            <td>A Basic resource indicating the status of the evaluation produced by evaluating the\n              order.</td>\n          </tr>\n          <tr>\n            <td>alternative</td>\n            <td>0..*</td>\n            <td><a href=\"../basic.html\">Basic</a><br/>(<a href=\"gao-alternate.html\">GAO\n                Alternate</a>)</td>\n            <td>Basic resources indicating the status of evaluations produced by evaluating\n              alternative orders suggested by the Decision Support Service Actor.</td>\n          </tr>\n          <tr>\n            <td>provenance</td>\n            <td>0..*</td>\n            <td><a href=\"../provenance.html\">Provenance</a></td>\n            <td>Provenance resources for the Result and Alternatives that can be used to verify that\n              those Resources came from a specific Decision Support Service. If the Decision Support\n              Service implements the Digital Signature option, there SHALL be one Provenance\n              resource for each Result or Alternate present in the output parameters.</td>\n          </tr>\n          <tr>\n            <td>dss</td>\n            <td>1..*</td>\n            <td><a href=\"../device.html\">Device</a></td>\n            <td>The Device resource shall identify the Decision Support Service device or devices\n              which evaluated the appropriateness of the order.</td>\n          </tr>\n          <tr>\n            <td>questions</td>\n            <td>0..*</td>\n            <td><a href=\"../questionnaire.html\">Questionnaire</a></td>\n            <td>A reference to one or more Questionnaire resources, which, if completed might\n              generate a different response from the Decision Support Service.</td>\n          </tr>\n          <tr>\n            <td>questionaireURI</td>\n            <td>0..1</td>\n            <td><a href=\"../datatypes.html#uri\">uri</a></td>\n            <td>Specifies a web endpoint where Questionnaire Resources returned by the Decision\n              Support Service can be invoked interactively. When the Decision Support Service\n              implements the Conversational Interaction Option and the questions parameter is\n              populated, this field SHALL be populated.</td>\n          </tr>\n        </tbody>\n      </table></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/gao-order-evaluate",
  "name": "GAO Evaluate Order",
  "status": "draft",
  "kind": "operation",
  "experimental": false,
  "description": "The evaluate operation examines an order, comparing it against known guidelines for appropriate use and returns the result of that evaluation to the caller.",
  "requirements": "This operation enables clinical decision support to be invoked prior to ordering to ensure appropriate use of resources.",
  "idempotent": true,
  "code": "evaluate",
  "comment": "This operation is normally idempotent, but can depend upon the algorithm used.",
  "system": false,
  "type": [
    "Order"
  ],
  "instance": false,
  "parameter": [
    {
      "name": "order",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The order to evaluate",
      "type": "Order",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/gao-order"
      }
    },
    {
      "name": "coverage",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Optional resources describing the patient’s coverage.",
      "type": "Coverage"
    },
    {
      "name": "answers",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Optional answers to any questions which have been or may be posed by the Decision Support Service",
      "type": "QuestionnaireResponse",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/gao-questionnaireresponse"
      }
    },
    {
      "name": "order",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The order that was evaluated. This is a copy of the order provided on input.",
      "type": "Order",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/gao-order"
      }
    },
    {
      "name": "answers",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "Answers to any questions posed by the Decision Support Service. This SHALL be a copy of the answers provided on input.",
      "type": "QuestionnaireResponse",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/gao-questionnaireresponse"
      }
    },
    {
      "name": "result",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "A Basic resource indicating the status of the evaluation produced by evaluating the order.",
      "type": "Basic",
      "_type": {
        "fhir_comments": [
          "  0..1 Description of meaning/use  "
        ]
      },
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/gao-result"
      }
    },
    {
      "name": "alternative",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "Basic resources indicating the status of evaluations produced by evaluating alternative orders suggested by the Decision Support Service Actor.",
      "type": "Basic",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/gao-alternate"
      }
    },
    {
      "name": "provenance",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "Provenance resources for the Result and Alternatives that can be used to verify that those Resources came from a specific Decision Support Service.         If the Decision Support Service implements the Digital Signature option, there SHALL be one Provenance resource for each Result or Alternate present in the output parameters.",
      "type": "Provenance"
    },
    {
      "name": "dss",
      "use": "out",
      "min": 1,
      "max": "*",
      "documentation": "The Device resource shall identify the Decision Support Service device or devices which evaluated the appropriateness of the order.",
      "type": "Device"
    },
    {
      "name": "questions",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "A reference to one or more Questionnaire resources, which, if completed might generate a different response from the Decision Support Service.",
      "type": "Questionnaire"
    },
    {
      "name": "questionaireURI",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Specifies a web endpoint where Questionnaire Resources returned by the Decision Support Service can be invoked interactively. When the Decision Support Service implements the Conversational Interaction Option and the questions parameter is populated, this field SHALL be populated.",
      "type": "uri"
    }
  ]
}